<?php

/*
 * Copyright 2008 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#namespace tehframework\reflection\annotations;

#use \InvalidArgumentException;

class TagDefinition
{
	/**
	 * @var string A name of the tag.
	 */
	public $name;
	
	/**
	 * @var string A text after the tag name.
	 */
	public $docString;
	
	/**
	 * Constructs a new DocBlock tag definition.
	 * 
	 * @param  string $name
	 *         A name of the tag.
	 * @param  string? $docString
	 *         A text after the tag name. Defaults to empty string.
	 * @throws InvalidArgumentException
	 *         If name is empty.
	 */
	public function __construct($name, $docString = null)
	{
		if (empty($name))
		{
			throw new InvalidArgumentException('Name cannot be empty.');
		}
		
		$this->name      = $name;
		$this->docString = $docString;
	}
	
	/**
	 * @return string
	 */
	public function __toString()
	{
		return '@' . $this->name . ' ' . $this->docString;
	}
}